Skip to content

Convert the remaining xdoc pages to Markdown - #24

Merged
slachiewicz merged 2 commits into
sourcefrom
agent/convert-xdoc-to-markdown
Aug 9, 2026
Merged

Convert the remaining xdoc pages to Markdown#24
slachiewicz merged 2 commits into
sourcefrom
agent/convert-xdoc-to-markdown

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

Converts the two remaining hand-written xdoc pages to Markdown with doxia-converter: get-involved.xml and ref/available-components.xml.

Please merge or rebase rather than squash — the rename is in its own commit so git log --follow keeps working, and squashing collapses it back into a delete plus an add.

404.xml deliberately stays xdoc. It carries a <head> block with <base href> plus absolute stylesheet and script links, and Doxia's Markdown parser turns front matter into only <title> and <meta> — there is no way to emit <base>, <link> or <script> from Markdown. A 404 page is served from arbitrary URLs, so that <base> cannot be dropped.

Verification

The site was rendered before and after and the two pages compared on title, author, visible text and link targets: identical, both of them.

The YAML front matter is kept and must stay the first bytes of each file: it carries the title and author, and without it the parser falls back to the first heading and <meta name="author"> disappears. Plexus parent 26 already excludes **/src/site/markdown/** from spotless's flexmark formatter, which would otherwise rewrite the fence closing the front matter.

Git's rename detection is similarity-based, so a rename and a rewrite in
one commit is recorded as a delete plus an add and git log --follow stops
there. Please merge or rebase rather than squash.

Generated-by: Claude Opus 5 (1M context)
get-involved and ref/available-components, converted with
doxia-converter. The YAML front matter is kept: it carries each page's
title and author, which the skin turns into <title> and
<meta name="author">.

404.xml stays xdoc on purpose. It carries a <head> block with a <base
href> and absolute stylesheet links, and Markdown front matter can only
produce <title> and <meta>; a 404 page is served from arbitrary URLs, so
the <base> cannot be dropped.

Verified by rendering the site before and after: both pages are identical
in title, author, visible text and every link target.

Generated-by: Claude Opus 5 (1M context)
@slachiewicz slachiewicz added documentation Improvements or additions to documentation maintenance Cleanup, refactoring or other internal change labels Aug 9, 2026
@slachiewicz
slachiewicz marked this pull request as ready for review August 9, 2026 17:15
@slachiewicz
slachiewicz merged commit f46f6cc into source Aug 9, 2026
14 checks passed
@slachiewicz
slachiewicz deleted the agent/convert-xdoc-to-markdown branch August 9, 2026 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation maintenance Cleanup, refactoring or other internal change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant